Azure Maps Feature State Service (preview:2023-03-01)

2025/10/06 • 8 deleted methods

FeatureState_CreateStateset (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). The Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here. This Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset. Once the stateset is created, users can use that `statesetId` to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. Feature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state's timestamp is later than the stored timestamp. Azure Maps MapControl provides a way to use these feature states to style the features. For more information, see the Render services [Get Map State Tile](/rest/api/maps/render/get-map-state-tile). ### Submit Create Request The `Create Stateset` API is an HTTP `POST` request used to create a new Stateset, defining the values and corresponding styles for its properties in the body of the request. For more information, see [Create a feature stateset](/azure/azure-maps/how-to-creator-feature-stateset).
Reference :  Link ¶

⚼ Request

POST:  /featureStateSets
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
datasetId:
{
Description: The datasetId must have been obtained from a successful [Dataset Create API](/rest/api/maps-creator/dataset/create) call. ,
Required: True ,
}
string ,
description:
{
Description: Description for the stateset. Max length allowed is 1000. ,
Required: False ,
}
string ,
styleRules:
{
Description: The stateset style JSON data. ,
Required: True ,
}
{
styles:
{
Description: An array of stateset style rules. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRule, StringRule and BooleanRule definitions [here](https://aka.ms/AzureMapsStatesetStyles). ,
Required: False ,
}
[
{
keyName:
{
Description: Stateset style key name. Key names are random strings but they should be unique inside style array. ,
Required: True ,
}
string ,
type:
{
Description: The type of stateset style. ,
Enum:
{
boolean: Boolean type of stateset style. ,
number: Number type of stateset style. ,
string: String type of stateset style. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (200)

{
statesetId:
{
Description: The ID for the new stateset created. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FeatureState_ListStatesets (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit List Statesets Request The `List Statesets` API is an HTTP `GET` request that returns a list of all existing statesets.
Reference :  Link ¶

⚼ Request

GET:  /featureStateSets
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
statesets:
{
Description: A list of statesets information. ,
Required: False ,
}
[
{
statesetId:
{
Description: The stateset ID of this stateset. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: If present, the location of the next page of data. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FeatureState_UpdateStateset (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit Update Stateset Request The `Update Stateset` API is an HTTP `PUT` request used to update the stateset style rules of the specified stateset.
Reference :  Link ¶

⚼ Request

PUT:  /featureStateSets/{statesetId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
statesetId:
{
Description: The stateset id that was created. ,
Required: True ,
}
string ,
styleRules:
{
Description: The stateset style JSON data. Only style rules are allowed to be updated, update on keyname and type is not allowed. ,
Required: True ,
}
{
styles:
{
Description: An array of stateset style rules. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRule, StringRule and BooleanRule definitions [here](https://aka.ms/AzureMapsStatesetStyles). ,
Required: False ,
}
[
{
keyName:
{
Description: Stateset style key name. Key names are random strings but they should be unique inside style array. ,
Required: True ,
}
string ,
type:
{
Description: The type of stateset style. ,
Enum:
{
boolean: Boolean type of stateset style. ,
number: Number type of stateset style. ,
string: String type of stateset style. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FeatureState_DeleteStateset (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit Delete Stateset Request The `Delete Stateset` API is an HTTP `DELETE` request used to delete the specified stateset and its associated data.
Reference :  Link ¶

⚼ Request

DELETE:  /featureStateSets/{statesetId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
statesetId:
{
Description: The stateset id that was created. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FeatureState_GetStateset (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit Get Stateset Request The `Get Stateset` API is an HTTP `GET` request used to retrieve the specified stateset information, including the `datasetId` associated to the stateset, and its styles.
Reference :  Link ¶

⚼ Request

GET:  /featureStateSets/{statesetId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
statesetId:
{
Description: The stateset id that was created. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
description:
{
Description: Description associated with the stateset. ,
Required: False ,
}
string ,
datasetIds:
{
Description: Dataset ID associated with the stateset. ,
Required: False ,
}
[
string ,
]
,
statesetStyle:
{
Description: The styles model. ,
Required: False ,
}
{
styles:
{
Description: An array of stateset style rules. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRule, StringRule and BooleanRule definitions [here](https://aka.ms/AzureMapsStatesetStyles). ,
Required: False ,
}
[
{
keyName:
{
Description: Stateset style key name. Key names are random strings but they should be unique inside style array. ,
Required: True ,
}
string ,
type:
{
Description: The type of stateset style. ,
Enum:
{
boolean: Boolean type of stateset style. ,
number: Number type of stateset style. ,
string: String type of stateset style. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FeatureState_UpdateStates (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit Update States Request The `Update States` API is a `PUT` request that allows the user to update the state of the specified feature in a given stateset.
Reference :  Link ¶

⚼ Request

PUT:  /featureStateSets/{statesetId}/featureStates/{featureId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
statesetId:
{
Description: The stateset id that was created. ,
Required: True ,
}
string ,
featureId:
{
Description: The id of a feature in the given dataset. If the featureId is not present in the dataset, Bad Request response will be returned. ,
Required: True ,
}
string ,
featureStates:
{
Description: The feature state JSON data. A feature can have only one state at a given point in time. The specified state keyname must have been defined during the stateset creation. ,
Required: True ,
}
{
states:
{
Description: The feature states array. ,
Required: False ,
}
[
{
keyName:
{
Description: Feature state Keyname. Maximum length allowed is 1000. ,
Required: False ,
}
string ,
value:
{
Description: Value for the feature state. Type should comply with the style definition attached to the featurestate. Maximum length allowed for string type is 1024. ,
Required: False ,
}
string ,
eventTimestamp:
{
Description: Valid Timestamp when the feature state was captured. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FeatureState_DeleteState (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit Delete State Request The `Delete State` API is an HTTP `DELETE` request is used to delete state information defined by the `stateKeyName` parameter for the specified feature as specified by the `featureId`.
Reference :  Link ¶

⚼ Request

DELETE:  /featureStateSets/{statesetId}/featureStates/{featureId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
statesetId:
{
Description: The stateset id that was created. ,
Required: True ,
}
string ,
featureId:
{
Description: The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned. ,
Required: True ,
}
string ,
stateKeyName:
{
Description: The Name of the state to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FeatureState_ListStates (removed)
Description :  > [!NOTE] > > **Azure Maps Creator retirement** > > The Azure Maps Creator indoor map service is now deprecated and will be retired on 9/30/25. For more information, see [End of Life Announcement of Azure Maps Creator](https://aka.ms/AzureMapsCreatorDeprecation). ### Submit List States Request The `List States` API is an HTTP `GET` request that returns the current state information associated with the given feature in the specified stateset.
Reference :  Link ¶

⚼ Request

GET:  /featureStateSets/{statesetId}/featureStates/{featureId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
statesetId:
{
Description: The stateset id that was created. ,
Required: True ,
}
string ,
featureId:
{
Description: The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
states:
{
Description: The feature states array. ,
Required: False ,
}
[
{
keyName:
{
Description: Feature state Keyname. Maximum length allowed is 1000. ,
Required: False ,
}
string ,
value:
{
Description: Value for the feature state. Type should comply with the style definition attached to the featurestate. Maximum length allowed for string type is 1024. ,
Required: False ,
}
string ,
eventTimestamp:
{
Description: Valid Timestamp when the feature state was captured. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}